/*
 * YAJHFC - Yet another Java Hylafax client
 * Copyright (C) 2005-2011 Jonas Wolz <info@yajhfc.de>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *  
 *  Linking YajHFC statically or dynamically with other modules is making 
 *  a combined work based on YajHFC. Thus, the terms and conditions of 
 *  the GNU General Public License cover the whole combination.
 *  In addition, as a special exception, the copyright holders of YajHFC 
 *  give you permission to combine YajHFC with modules that are loaded using
 *  the YajHFC plugin interface as long as such plugins do not attempt to
 *  change the application's name (for example they may not change the main window title bar 
 *  and may not replace or change the About dialog).
 *  You may copy and distribute such a system following the terms of the
 *  GNU GPL for YajHFC and the licenses of the other code concerned,
 *  provided that you include the source code of that other code when 
 *  and as the GNU GPL requires distribution of source code.
 *  
 *  Note that people who make modified versions of YajHFC are not obligated to grant 
 *  this special exception for their modified versions; it is their choice whether to do so.
 *  The GNU General Public License gives permission to release a modified 
 *  version without this exception; this exception also makes it possible 
 *  to release a modified version which carries forward this exception.
 */
package yajhfc.phonebook;

import java.util.EventObject;
import java.util.List;

/**
 * @author jonas
 *
 */
public class PhonebookEvent extends EventObject {
    protected final int[] indices;
    protected final PhoneBookEntry[] entries;
    
    public PhonebookEvent(PhoneBookEntryList source, PhoneBookEntry[] entries, int[] indices) {
        super(source);
        this.entries = entries;
        this.indices = indices;
    }
    
    /**
     * The source phone book
     * @return
     */
    public PhoneBookEntryList getPhonebook() {
        return (PhoneBookEntryList)source;
    }

    /**
     * The affected indices.
     * This list is guaranteed to be in ascending order.
     * @return
     */
    public int[] getIndices() {
        return indices;
    }

    /**
     * The affected entries.
     * This list is guaranteed to have the same order as getIndices(), i.e. getPhonebook().getEntries().get(getIndices()[i]) == getEntries()[i]
     * before (for removed) or at the time of this event (for add/change)
     * @return
     */
    public PhoneBookEntry[] getEntries() {
        return entries;
    }
    
    /**
     * Creates an event object for the given interval of indices
     * @param source
     * @param intervalStart
     * @param intervalEnd
     * @return
     */
    public static PhonebookEvent createForInterval(PhoneBookEntryList source, int intervalStart, int intervalEnd) {
        if (intervalEnd < intervalStart) {
            // Make sure that intervalStart <= intervalEnd
            int t = intervalEnd;
            intervalEnd = intervalStart;
            intervalStart = t;
        }
        int[] indices = new int[intervalEnd - intervalStart + 1];
        PhoneBookEntry[] entries = new PhoneBookEntry[intervalEnd - intervalStart + 1];
        List<PhoneBookEntry> entryList = source.getEntries();
        
        for (int i=intervalStart; i <= intervalEnd; i++) {
            int idx = i-intervalStart;
            indices[idx] = i;
            entries[idx] = entryList.get(i);
        }
        
        return new PhonebookEvent(source, entries, indices);
    }
}
